/*! \file shr_pmac.h
 *
 * Shared address format for Port/MAC drivers.
 *
 * The address format is a uniform representation of a Port/MAC
 * register address. An access driver (typically a CMIC driver) will
 * convert the uniform representation into a suitable hardware
 * format.
 */
/*
 * Copyright: (c) 2018 Broadcom. All Rights Reserved. "Broadcom" refers to 
 * Broadcom Limited and/or its subsidiaries.
 * 
 * Broadcom Switch Software License
 * 
 * This license governs the use of the accompanying Broadcom software. Your 
 * use of the software indicates your acceptance of the terms and conditions 
 * of this license. If you do not agree to the terms and conditions of this 
 * license, do not use the software.
 * 1. Definitions
 *    "Licensor" means any person or entity that distributes its Work.
 *    "Software" means the original work of authorship made available under 
 *    this license.
 *    "Work" means the Software and any additions to or derivative works of 
 *    the Software that are made available under this license.
 *    The terms "reproduce," "reproduction," "derivative works," and 
 *    "distribution" have the meaning as provided under U.S. copyright law.
 *    Works, including the Software, are "made available" under this license 
 *    by including in or with the Work either (a) a copyright notice 
 *    referencing the applicability of this license to the Work, or (b) a copy 
 *    of this license.
 * 2. Grant of Copyright License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    copyright license to reproduce, prepare derivative works of, publicly 
 *    display, publicly perform, sublicense and distribute its Work and any 
 *    resulting derivative works in any form.
 * 3. Grant of Patent License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    patent license to make, have made, use, offer to sell, sell, import, and 
 *    otherwise transfer its Work, in whole or in part. This patent license 
 *    applies only to the patent claims licensable by Licensor that would be 
 *    infringed by Licensor's Work (or portion thereof) individually and 
 *    excluding any combinations with any other materials or technology.
 *    If you institute patent litigation against any Licensor (including a 
 *    cross-claim or counterclaim in a lawsuit) to enforce any patents that 
 *    you allege are infringed by any Work, then your patent license from such 
 *    Licensor to the Work shall terminate as of the date such litigation is 
 *    filed.
 * 4. Redistribution
 *    You may reproduce or distribute the Work only if (a) you do so under 
 *    this License, (b) you include a complete copy of this License with your 
 *    distribution, and (c) you retain without modification any copyright, 
 *    patent, trademark, or attribution notices that are present in the Work.
 * 5. Derivative Works
 *    You may specify that additional or different terms apply to the use, 
 *    reproduction, and distribution of your derivative works of the Work 
 *    ("Your Terms") only if (a) Your Terms provide that the limitations of 
 *    Section 7 apply to your derivative works, and (b) you identify the 
 *    specific derivative works that are subject to Your Terms. 
 *    Notwithstanding Your Terms, this license (including the redistribution 
 *    requirements in Section 4) will continue to apply to the Work itself.
 * 6. Trademarks
 *    This license does not grant any rights to use any Licensor's or its 
 *    affiliates' names, logos, or trademarks, except as necessary to 
 *    reproduce the notices described in this license.
 * 7. Limitations
 *    Platform. The Work and any derivative works thereof may only be used, or 
 *    intended for use, with a Broadcom switch integrated circuit.
 *    No Reverse Engineering. You will not use the Work to disassemble, 
 *    reverse engineer, decompile, or attempt to ascertain the underlying 
 *    technology of a Broadcom switch integrated circuit.
 * 8. Termination
 *    If you violate any term of this license, then your rights under this 
 *    license (including the license grants of Sections 2 and 3) will 
 *    terminate immediately.
 * 9. Disclaimer of Warranty
 *    THE WORK IS PROVIDED "AS IS" WITHOUT WARRANTIES OR CONDITIONS OF ANY 
 *    KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WARRANTIES OR CONDITIONS OF 
 *    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR 
 *    NON-INFRINGEMENT. YOU BEAR THE RISK OF UNDERTAKING ANY ACTIVITIES UNDER 
 *    THIS LICENSE. SOME STATES' CONSUMER LAWS DO NOT ALLOW EXCLUSION OF AN 
 *    IMPLIED WARRANTY, SO THIS DISCLAIMER MAY NOT APPLY TO YOU.
 * 10. Limitation of Liability
 *    EXCEPT AS PROHIBITED BY APPLICABLE LAW, IN NO EVENT AND UNDER NO LEGAL 
 *    THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE 
 *    SHALL ANY LICENSOR BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY DIRECT, 
 *    INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF 
 *    OR RELATED TO THIS LICENSE, THE USE OR INABILITY TO USE THE WORK 
 *    (INCLUDING BUT NOT LIMITED TO LOSS OF GOODWILL, BUSINESS INTERRUPTION, 
 *    LOST PROFITS OR DATA, COMPUTER FAILURE OR MALFUNCTION, OR ANY OTHER 
 *    COMMERCIAL DAMAGES OR LOSSES), EVEN IF THE LICENSOR HAS BEEN ADVISED OF 
 *    THE POSSIBILITY OF SUCH DAMAGES.
 */

#ifndef SHR_PMAC_H
#define SHR_PMAC_H

/*!
 * \brief Port/MAC register types
 *
 * The types of Port/MAC register.
 */
typedef enum shr_pmac_reg_type_e {
    SHR_PMAC_REGTYPE_BLK = 0,   /*!< To access block register */
    SHR_PMAC_REGTYPE_PORT = 1,  /*!< To access port register */
    SHR_PMAC_REGTYPE_MEM = 2,   /*!< To access block memory */
    SHR_PMAC_REGTYPE_COUNT      /*!< Must be last */
} shr_pmac_reg_type_t;

/*!
 * \brief Macros for Port/MAC address format
 *
 * Portamc address is 32 bits and the layout is,
 * <b> acc_type (2b) | reg_type (2b) | reg_offset (28b) </b>
 *
 * \arg acc_type: Access Type
 * \arg reg_type: \ref shr_pmac_reg_type_e
 * \arg reg_offset: Register offset
 *
 * \{
 */
#define SHR_PMAC_ACC_TYPE_MASK   (0x3)          /*!< Access type mask */
#define SHR_PMAC_ACC_TYPE_OFFSET (30)           /*!< Access type offset */
#define SHR_PMAC_REG_TYPE_MASK   (0x3)          /*!< Register type mask */
#define SHR_PMAC_REG_TYPE_OFFSET (28)           /*!< Register type offset */
#define SHR_PMAC_REG_ADDR_MASK   (0xfffffff)    /*!< Register addr mask */
#define SHR_PMAC_REG_ADDR_OFFSET (0)            /*!< Register addr offset */
/*! \} */

/*!
 * \addtogroup PortMAC_Address_Manipulation
 *
 * \brief Macros for Port/MAC address mainpulations.
 *
 * Only decoding (GET) macros are required.
 *
 * \{
 */

/*! Get access type from the Port/MAC address */
#define SHR_PMAC_ACC_TYPE_GET(_addr) \
    ((_addr >> SHR_PMAC_ACC_TYPE_OFFSET) & SHR_PMAC_ACC_TYPE_MASK)

/*! Get register type from the Port/MAC address */
#define SHR_PMAC_REG_TYPE_GET(_addr) \
    ((_addr >> SHR_PMAC_REG_TYPE_OFFSET) & SHR_PMAC_REG_TYPE_MASK)

/*! Get register address from the Port/MAC address */
#define SHR_PMAC_REG_ADDR_GET(_addr) \
    ((_addr >> SHR_PMAC_REG_ADDR_OFFSET) & SHR_PMAC_REG_ADDR_MASK)

/*! \} */

#endif  /* SHR_PMAC_H */
